Docs: Add Development Guide to Contributing Guidelines #56
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
angel1254mc
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Hi! Thought this was a cool project and wanted to try and contribute to it 😄 I just added some README changes I thought would be useful to developers that are new to the codebase!
What this PR does
This PR adds a development guide to the contributing section of the README running through the steps needed to add a new Scraper to the library. This should hopefully help new contributors gain a footing with the codebase quickly, and make the task of adding a new scraper more straightfoward :)
I've also added some extra bits containing information about the Recipe Structured Data format that a couple of scrapers leverage already.
Open to any feedback and if you feel these changes are not necessary feel free to close :)